[20733] Fix support for @key annotation in Dynamic types #4694

EduPonz · 2024-04-17T12:45:06Z

Description

This PR:

Fixes various things regarding the handling of @key annotation on dynamic types:
- Copy the type annotations when creating MemberDescriptors
- Fix AnnotationDescriptor::key_annotation() implementation
- Fix population of is_key_defined_ in DynamicType::copy_from_builder()
- Simplify DynamicType::key_annotation() implementation
On loading types from XML, add the @key annotation only to the member builder and not to the dynamic type, as @key only makes sense for members but not types.
Adds the key attribute to members in XSD

@Mergifyio backport 2.13.x 2.10.x 2.6.x

Contributor Checklist

Commit messages follow the project guidelines.
The code follows the style guidelines of this project.
Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
N/A: Any new/modified methods have been properly documented using Doxygen.
N/A: Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
Changes are ABI compatible.
Changes are API compatible.
N/A: New feature has been added to the versions.md file (if applicable).
New feature has been documented/Current behavior is correctly described in the documentation.
- Related documentation PR: [20733] Document how to annotate members as key in XML types Fast-DDS-docs#746
Applicable backports have been included in the description.

Reviewer Checklist

The PR has a milestone assigned.
The title and description correctly express the PR's purpose.
Check contributor checklist is correct.
Check CI results: changes do not issue any warning.
Check CI results: failing tests are unrelated with the changes.

Signed-off-by: eduponz <eduardoponz@eprosima.com>

src/cpp/dynamic-types/AnnotationDescriptor.cpp

src/cpp/dynamic-types/MemberDescriptor.cpp

MiguelCompany · 2024-04-29T14:54:33Z

Note: both suggestions don't require CI to be launched again

Additionally, the PR description does not indicate the fixes performed in DynamicTypes regarding key annotations

EduPonz · 2024-04-30T05:14:03Z

CI passed on b76cfdc, the changes in 2519f21 are merely cosmetic

Signed-off-by: eduponz <eduardoponz@eprosima.com>

MiguelCompany · 2024-04-30T05:53:48Z

@Mergifyio backport 2.13.x 2.10.x 2.6.x

mergify · 2024-04-30T05:53:58Z

backport 2.13.x 2.10.x 2.6.x

✅ Backports have been created

#4747 [20733] Fix support for @key annotation in Dynamic types (backport #4694) has been created for branch 2.13.x
#4748 [20733] Fix support for @key annotation in Dynamic types (backport #4694) has been created for branch 2.10.x
#4749 [20733] Fix support for @key annotation in Dynamic types (backport #4694) has been created for branch 2.6.x but encountered conflicts

* Refs #20733: Fix support for key annotation in XML types Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Add test Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Move implementations to cpp Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Properly fix key annotation handling Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit eaa23db)

* Refs #20733: Fix support for key annotation in XML types Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Add test Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Move implementations to cpp Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Properly fix key annotation handling Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit eaa23db) # Conflicts: # resources/xsd/fastRTPS_profiles.xsd # test/system/tools/xmlvalidation/XMLTesterExample_profile.xml # test/system/tools/xmlvalidation/all_profile.xml # test/system/tools/xmlvalidation/types_profile.xml

* Refs #20733: Fix support for key annotation in XML types Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Add test Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Move implementations to cpp Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Properly fix key annotation handling Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit eaa23db)

* Refs #20733: Fix support for key annotation in XML types Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Add test Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Move implementations to cpp Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Properly fix key annotation handling Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit eaa23db) Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>

* Refs #20733: Fix support for key annotation in XML types Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Add test Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Move implementations to cpp Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Properly fix key annotation handling Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit eaa23db)

* Refs #20733: Fix support for key annotation in XML types Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Add test Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Move implementations to cpp Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Properly fix key annotation handling Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20733: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit eaa23db) Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>

EduPonz added this to the v2.14.1 milestone Apr 17, 2024

EduPonz mentioned this pull request Apr 17, 2024

[20733] Document how to annotate members as key in XML types eProsima/Fast-DDS-docs#746

Merged

8 tasks

EduPonz added to-do needs-review PR that is ready to be reviewed and removed to-do labels Apr 23, 2024

EduPonz marked this pull request as ready for review April 24, 2024 13:25

EduPonz force-pushed the hotfix/key_annotation_xml_types branch from ab60fe9 to 4e79d8b Compare April 24, 2024 13:27

pablogs9 previously approved these changes Apr 24, 2024

View reviewed changes

EduPonz dismissed pablogs9’s stale review via b2bd867 April 24, 2024 13:37

pablogs9 previously approved these changes Apr 24, 2024

View reviewed changes

MiguelCompany previously approved these changes Apr 24, 2024

View reviewed changes

EduPonz requested a review from MiguelCompany April 25, 2024 04:56

EduPonz removed the needs-review PR that is ready to be reviewed label Apr 25, 2024

github-actions bot added the ci-pending PR which CI is running label Apr 25, 2024

EduPonz added 3 commits April 29, 2024 15:13

Refs #20733: Fix support for key annotation in XML types

121bef6

Signed-off-by: eduponz <eduardoponz@eprosima.com>

Refs #20733: Add test

ab1884d

Signed-off-by: eduponz <eduardoponz@eprosima.com>

Refs #20733: Move implementations to cpp

f3feee5

Signed-off-by: eduponz <eduardoponz@eprosima.com>

EduPonz dismissed stale reviews from MiguelCompany and pablogs9 via b955060 April 29, 2024 13:14

EduPonz force-pushed the hotfix/key_annotation_xml_types branch from b2bd867 to b955060 Compare April 29, 2024 13:14

Refs #20733: Properly fix key annotation handling

b76cfdc

Signed-off-by: eduponz <eduardoponz@eprosima.com>

EduPonz force-pushed the hotfix/key_annotation_xml_types branch from b955060 to b76cfdc Compare April 29, 2024 14:15

MiguelCompany requested changes Apr 29, 2024

View reviewed changes

src/cpp/dynamic-types/AnnotationDescriptor.cpp Outdated Show resolved Hide resolved

src/cpp/dynamic-types/MemberDescriptor.cpp Outdated Show resolved Hide resolved

MiguelCompany self-requested a review April 29, 2024 14:53

EduPonz added skip-ci Automatically pass CI and removed ci-pending PR which CI is running labels Apr 30, 2024

EduPonz changed the title ~~[20733] Fix support for @key annotation in XML types~~ [20733] Fix support for @key annotation in Dynamic types Apr 30, 2024

EduPonz force-pushed the hotfix/key_annotation_xml_types branch from 92b62ee to 8c415ee Compare April 30, 2024 05:13

EduPonz force-pushed the hotfix/key_annotation_xml_types branch from 8c415ee to 1380e97 Compare April 30, 2024 05:16

Refs #20733: Apply Miguel's suggestions

2519f21

Signed-off-by: eduponz <eduardoponz@eprosima.com>

EduPonz force-pushed the hotfix/key_annotation_xml_types branch from 1380e97 to 2519f21 Compare April 30, 2024 05:17

MiguelCompany approved these changes Apr 30, 2024

View reviewed changes

MiguelCompany merged commit eaa23db into master Apr 30, 2024
3 checks passed

MiguelCompany deleted the hotfix/key_annotation_xml_types branch April 30, 2024 05:52

mergify bot mentioned this pull request Apr 30, 2024

[20733] Fix support for @key annotation in Dynamic types (backport #4694) #4747

Merged

12 tasks

EduPonz mentioned this pull request May 6, 2024

Support for Key topics eProsima/fastdds-visualizer-plugin#56

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[20733] Fix support for @key annotation in Dynamic types #4694

[20733] Fix support for @key annotation in Dynamic types #4694

EduPonz commented Apr 17, 2024 •

edited by MiguelCompany

Loading

MiguelCompany commented Apr 29, 2024

EduPonz commented Apr 30, 2024 •

edited

Loading

MiguelCompany commented Apr 30, 2024

mergify bot commented Apr 30, 2024 •

edited

Loading

[20733] Fix support for @key annotation in Dynamic types #4694

[20733] Fix support for @key annotation in Dynamic types #4694

Conversation

EduPonz commented Apr 17, 2024 • edited by MiguelCompany Loading

Description

Contributor Checklist

Reviewer Checklist

MiguelCompany commented Apr 29, 2024

EduPonz commented Apr 30, 2024 • edited Loading

MiguelCompany commented Apr 30, 2024

mergify bot commented Apr 30, 2024 • edited Loading

✅ Backports have been created

EduPonz commented Apr 17, 2024 •

edited by MiguelCompany

Loading

EduPonz commented Apr 30, 2024 •

edited

Loading

mergify bot commented Apr 30, 2024 •

edited

Loading